<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2011 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> * <a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License"); you may not<a name="line.4"></a>
<span class="sourceLineNo">005</span> * use this file except in compliance with the License. You may obtain a copy of<a name="line.5"></a>
<span class="sourceLineNo">006</span> * the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> * <a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> * <a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the<a name="line.12"></a>
<span class="sourceLineNo">013</span> * License for the specific language governing permissions and limitations under<a name="line.13"></a>
<span class="sourceLineNo">014</span> * the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.Beta;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.annotations.GwtCompatible;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Comparator;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Iterator;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.SortedSet;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * A {@link Multiset} which maintains the ordering of its elements, according to<a name="line.28"></a>
<span class="sourceLineNo">029</span> * either their natural order or an explicit {@link Comparator}. In all cases,<a name="line.29"></a>
<span class="sourceLineNo">030</span> * this implementation uses {@link Comparable#compareTo} or<a name="line.30"></a>
<span class="sourceLineNo">031</span> * {@link Comparator#compare} instead of {@link Object#equals} to determine<a name="line.31"></a>
<span class="sourceLineNo">032</span> * equivalence of instances.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * <a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; The comparison must be &lt;i&gt;consistent with equals&lt;/i&gt; as<a name="line.34"></a>
<span class="sourceLineNo">035</span> * explained by the {@link Comparable} class specification. Otherwise, the<a name="line.35"></a>
<span class="sourceLineNo">036</span> * resulting multiset will violate the {@link Collection} contract, which it is<a name="line.36"></a>
<span class="sourceLineNo">037</span> * specified in terms of {@link Object#equals}.<a name="line.37"></a>
<span class="sourceLineNo">038</span> * <a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;See the Guava User Guide article on &lt;a href=<a name="line.39"></a>
<span class="sourceLineNo">040</span> * "http://code.google.com/p/guava-libraries/wiki/NewCollectionTypesExplained#Multiset"&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * {@code Multiset}&lt;/a&gt;.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * <a name="line.42"></a>
<span class="sourceLineNo">043</span> * @author Louis Wasserman<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @since 11.0<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>@Beta<a name="line.46"></a>
<span class="sourceLineNo">047</span>@GwtCompatible<a name="line.47"></a>
<span class="sourceLineNo">048</span>public interface SortedMultiset&lt;E&gt; extends Multiset&lt;E&gt;, SortedIterable&lt;E&gt; {<a name="line.48"></a>
<span class="sourceLineNo">049</span>  /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>   * Returns the comparator that orders this multiset, or<a name="line.50"></a>
<span class="sourceLineNo">051</span>   * {@link Ordering#natural()} if the natural ordering of the elements is used.<a name="line.51"></a>
<span class="sourceLineNo">052</span>   */<a name="line.52"></a>
<span class="sourceLineNo">053</span>  Comparator&lt;? super E&gt; comparator();<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>  /**<a name="line.55"></a>
<span class="sourceLineNo">056</span>   * Returns the entry of the first element in this multiset, or {@code null} if<a name="line.56"></a>
<span class="sourceLineNo">057</span>   * this multiset is empty.<a name="line.57"></a>
<span class="sourceLineNo">058</span>   */<a name="line.58"></a>
<span class="sourceLineNo">059</span>  Entry&lt;E&gt; firstEntry();<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>  /**<a name="line.61"></a>
<span class="sourceLineNo">062</span>   * Returns the entry of the last element in this multiset, or {@code null} if<a name="line.62"></a>
<span class="sourceLineNo">063</span>   * this multiset is empty.<a name="line.63"></a>
<span class="sourceLineNo">064</span>   */<a name="line.64"></a>
<span class="sourceLineNo">065</span>  Entry&lt;E&gt; lastEntry();<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>  /**<a name="line.67"></a>
<span class="sourceLineNo">068</span>   * Returns and removes the entry associated with the lowest element in this<a name="line.68"></a>
<span class="sourceLineNo">069</span>   * multiset, or returns {@code null} if this multiset is empty.<a name="line.69"></a>
<span class="sourceLineNo">070</span>   */<a name="line.70"></a>
<span class="sourceLineNo">071</span>  Entry&lt;E&gt; pollFirstEntry();<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>  /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>   * Returns and removes the entry associated with the greatest element in this<a name="line.74"></a>
<span class="sourceLineNo">075</span>   * multiset, or returns {@code null} if this multiset is empty.<a name="line.75"></a>
<span class="sourceLineNo">076</span>   */<a name="line.76"></a>
<span class="sourceLineNo">077</span>  Entry&lt;E&gt; pollLastEntry();<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>  /**<a name="line.79"></a>
<span class="sourceLineNo">080</span>   * Returns a {@link SortedSet} view of the distinct elements in this multiset.<a name="line.80"></a>
<span class="sourceLineNo">081</span>   */<a name="line.81"></a>
<span class="sourceLineNo">082</span>  @Override SortedSet&lt;E&gt; elementSet();<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span>  /**<a name="line.84"></a>
<span class="sourceLineNo">085</span>   * {@inheritDoc}<a name="line.85"></a>
<span class="sourceLineNo">086</span>   *<a name="line.86"></a>
<span class="sourceLineNo">087</span>   * &lt;p&gt;The iterator returns the elements in ascending order according to this<a name="line.87"></a>
<span class="sourceLineNo">088</span>   * multiset's comparator.<a name="line.88"></a>
<span class="sourceLineNo">089</span>   */<a name="line.89"></a>
<span class="sourceLineNo">090</span>  @Override Iterator&lt;E&gt; iterator();<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>  /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>   * Returns a descending view of this multiset. Modifications made to either<a name="line.93"></a>
<span class="sourceLineNo">094</span>   * map will be reflected in the other.<a name="line.94"></a>
<span class="sourceLineNo">095</span>   */<a name="line.95"></a>
<span class="sourceLineNo">096</span>  SortedMultiset&lt;E&gt; descendingMultiset();<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>  /**<a name="line.98"></a>
<span class="sourceLineNo">099</span>   * Returns a view of this multiset restricted to the elements less than<a name="line.99"></a>
<span class="sourceLineNo">100</span>   * {@code upperBound}, optionally including {@code upperBound} itself. The<a name="line.100"></a>
<span class="sourceLineNo">101</span>   * returned multiset is a view of this multiset, so changes to one will be<a name="line.101"></a>
<span class="sourceLineNo">102</span>   * reflected in the other. The returned multiset supports all operations that<a name="line.102"></a>
<span class="sourceLineNo">103</span>   * this multiset supports.<a name="line.103"></a>
<span class="sourceLineNo">104</span>   * <a name="line.104"></a>
<span class="sourceLineNo">105</span>   * &lt;p&gt;The returned multiset will throw an {@link IllegalArgumentException} on<a name="line.105"></a>
<span class="sourceLineNo">106</span>   * attempts to add elements outside its range.<a name="line.106"></a>
<span class="sourceLineNo">107</span>   */<a name="line.107"></a>
<span class="sourceLineNo">108</span>  SortedMultiset&lt;E&gt; headMultiset(E upperBound, BoundType boundType);<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>  /**<a name="line.110"></a>
<span class="sourceLineNo">111</span>   * Returns a view of this multiset restricted to the range between<a name="line.111"></a>
<span class="sourceLineNo">112</span>   * {@code lowerBound} and {@code upperBound}. The returned multiset is a view<a name="line.112"></a>
<span class="sourceLineNo">113</span>   * of this multiset, so changes to one will be reflected in the other. The<a name="line.113"></a>
<span class="sourceLineNo">114</span>   * returned multiset supports all operations that this multiset supports.<a name="line.114"></a>
<span class="sourceLineNo">115</span>   * <a name="line.115"></a>
<span class="sourceLineNo">116</span>   * &lt;p&gt;The returned multiset will throw an {@link IllegalArgumentException} on<a name="line.116"></a>
<span class="sourceLineNo">117</span>   * attempts to add elements outside its range.<a name="line.117"></a>
<span class="sourceLineNo">118</span>   * <a name="line.118"></a>
<span class="sourceLineNo">119</span>   * &lt;p&gt;This method is equivalent to<a name="line.119"></a>
<span class="sourceLineNo">120</span>   * {@code tailMultiset(lowerBound, lowerBoundType).headMultiset(upperBound,<a name="line.120"></a>
<span class="sourceLineNo">121</span>   * upperBoundType)}.<a name="line.121"></a>
<span class="sourceLineNo">122</span>   */<a name="line.122"></a>
<span class="sourceLineNo">123</span>  SortedMultiset&lt;E&gt; subMultiset(E lowerBound, BoundType lowerBoundType,<a name="line.123"></a>
<span class="sourceLineNo">124</span>      E upperBound, BoundType upperBoundType);<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span>  /**<a name="line.126"></a>
<span class="sourceLineNo">127</span>   * Returns a view of this multiset restricted to the elements greater than<a name="line.127"></a>
<span class="sourceLineNo">128</span>   * {@code lowerBound}, optionally including {@code lowerBound} itself. The<a name="line.128"></a>
<span class="sourceLineNo">129</span>   * returned multiset is a view of this multiset, so changes to one will be<a name="line.129"></a>
<span class="sourceLineNo">130</span>   * reflected in the other. The returned multiset supports all operations that<a name="line.130"></a>
<span class="sourceLineNo">131</span>   * this multiset supports.<a name="line.131"></a>
<span class="sourceLineNo">132</span>   * <a name="line.132"></a>
<span class="sourceLineNo">133</span>   * &lt;p&gt;The returned multiset will throw an {@link IllegalArgumentException} on<a name="line.133"></a>
<span class="sourceLineNo">134</span>   * attempts to add elements outside its range.<a name="line.134"></a>
<span class="sourceLineNo">135</span>   */<a name="line.135"></a>
<span class="sourceLineNo">136</span>  SortedMultiset&lt;E&gt; tailMultiset(E lowerBound, BoundType boundType);<a name="line.136"></a>
<span class="sourceLineNo">137</span>}<a name="line.137"></a>




























































</pre>
</div>
</body>
</html>
